home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / pcburm13.zip / PCBURM.DOC < prev    next >
Text File  |  1992-11-11  |  14KB  |  358 lines
  1.                                   PCBURM
  2.                                 -----------
  3.  
  4.                          PCBoard User Ratio Monitor
  5.  
  6.                    A PCBoard File/Byte Download Monitor
  7.  
  8.                                Version 1.3
  9.  
  10.                             For PCBoard v14.5a
  11.  
  12.  
  13.                                 - - - - -
  14.  
  15.  
  16.                        Copyright 1992 - Robert Neal
  17.                                 317 Hickory
  18.                            Romeoville, IL  60441
  19.  
  20.                                Support BBS:
  21.                        Corporate Headquarters BBS
  22.                  Node #1: (815) 886-3233  14400 v.32bis
  23.                  Node #2: (815) 886-9381  14400 v.32bis
  24.  
  25.  
  26.  
  27.  
  28. |Changes to this documentation file from the previous version are
  29. |indicated by "|" in the left hand margin. This should make finding
  30. |changes to the documentation much easier and faster for those upgrading
  31. |from previous versions.
  32.  
  33.  
  34.  
  35.                            PROGRAM INFORMATION
  36.                            ===================
  37.  
  38. PCBoard User Ratio Monitor (PCBURM) is a utility door written for PCBoard
  39. v14.5a. PCBURM will enforce your desired ratios with each call the user makes
  40. to your board. PCBURM was written because PCBoard lacks a ratio enforcement
  41. method that is easy to use and understand, and one that can be run "real
  42. time". In looking around for similar products, everyone I've seen seem to be
  43. overkill, didn't effectively handle particular user requirements or just plain
  44. didn't seem to work.
  45.  
  46. In creating PCBURM, it was designed to be just one thing, a file/byte
  47. monitoring and enforcement tool for PCBoard. PCBURM will check for either a
  48. file ratio, byte ratio or both, sysop defined. There is no "banking" features,
  49. message ratio monitoring or things of that sort. This was decided so that
  50. PCBURM would be SIMPLE AND EASY for any sysop to get up and running in a
  51. matter of minutes.
  52.  
  53. Features of PCBURM:
  54.  
  55.         o Support for baud rates up to 115,200 bps
  56.         o Support for non-standard COM IRQ's
  57.         o Complete monitoring of COM ports for carrier loss
  58.         o Option to display comment to user
  59.         o Option to exclude security levels
  60.         o Option to print log information to CALLERx file
  61.         o Full Multi-Node support
  62.         o Sysop function keys are supported
  63.         o Most of all - SIMPLE to use
  64. |       o Supports Fossil driver (for PCBoard /M version)
  65.  
  66.  
  67.  
  68.                       PROGRAM INSTALLATION/OPERATION
  69.                       ==============================
  70.  
  71.  
  72. Step #1: - Create configuration file
  73. ========
  74.  
  75. |Edit PCBURM configuration file, PCBURM.CFG using the program URMCFG.EXE
  76. |included with PCBURM. You may also manually edit PCBURM.CFG using your
  77. |favorite text editor.
  78.  
  79. The items in the configuration file are as follows, do not include the line
  80. number references. Refer to detailed explanation below for each line:
  81.  
  82.         PCBURM.CFG
  83.         ------------------------------------------
  84. Line 1: C:\PCB\USERS.SYS
  85. Line 2: Corp Headquarters
  86. Line 3: Bob
  87. Line 4: Neal
  88. Line 5: 0
  89. Line 6: PCBURM.LOG
  90. Line 7: 1
  91. Line 8: 50000
  92. Line 9: /10/25/50          (or the word NONE)
  93. Line10: STRICT             (or the word NOSTRICT)
  94.  
  95. Line 1: Enter full path/filename of your USERS.SYS file. PCBURM supports the
  96.         PCB environment variables, %PCBDRIVE% and %PCBDIR%. Those running a
  97.         multi-node system may wish to replace this line with the following:
  98.  
  99.                 %PCBDRIVE%%PCBDIR%\USERS.SYS
  100.  
  101.         PCBURM will read the current PCBoard drive and directory from these
  102.         variables.
  103.  
  104. Line 2: BBS Name
  105.  
  106. Line 3: Sysop's first name
  107.  
  108. Line 4: Sysop's last name
  109.  
  110. Line 5: Registration number, leave as 0 if not registered. You will be
  111.         be provided with a registration number to enter here when you
  112.         send you payment.
  113.  
  114. Line 6: If you place the word CALLER on this line, PCBURM will write it's log
  115.         information PCBoard's CALLERx file. I find this handy as I can
  116.         see each users status each time I scan my CALLERx file.
  117.  
  118.         You can also have PCBURM maintain it's own log file by placing the
  119.         full path/filename to be written to on this line. The log file created
  120.         will include the name of the user, node used, security level assigned
  121.         to the user as well as the date and a brief text line explaining what
  122.         ratio enforcements were placed on the user. If a user exceeded his
  123.         requirements, the log file will include the current ratios of the user
  124.         at the time the program monitored his activity.
  125.  
  126. Line 7: Free FILE credits to be given. You may use this line to give "free"
  127.         credits to new users. If you would like to grant some "free" credits
  128.         to a user, place the value here. In the above example, a new user
  129.         would be given credit for one upload. If a user was given a 5:1 file
  130.         ratio requirement, he could then download 5 files before needing to
  131.         upload anything. After downloading 5 files PCBURM would restrict
  132.         download ability until a file was uploaded.
  133.  
  134. Line 8: Free BYTE credits to be given. Same explanation for the file credit.
  135.         Using the above example, a new user could download 250,000 bytes if a
  136.         5:1 ratio was in place before he would need to upload anything. This
  137.         option allows new users access to your file area without requiring an
  138.         initial upload.
  139.  
  140.         Please note that the values used on line 7 and 8 are used internally
  141.         to the program. It will not actually add this information to the users
  142.         file, therefore keeping your user file statistics accurate (unlike
  143.         some other similar type of programs).
  144.  
  145. Line 9: You can optionally exclude specific security levels from ratio check
  146.         by placing the levels desired on this line. Seperate each level with
  147.         the "/" character, see example above. Place the word NONE on this line
  148.         if you do not wish to exclude any security levels from ratio check.
  149.  
  150. Line10: You can select if you want PCBURM to enforce a STRICT byte ratio
  151.         requirement or not. Placing the word STRICT on this line would
  152.         cause PCBURM to calculate the remaining number of bytes the user
  153.         could download. PCBURM will use this calculated figure if it is
  154.         less than the number of bytes granted a user in the PWRD file.
  155.         Put the word NOSTRICT on this line if you do not want this
  156.         feature, instead PCBURM will grant a daily download bytes equal
  157.         to what you have indicated in the PWRD file.
  158.  
  159.  
  160.  
  161.  
  162.  
  163. Step #2: - Create file ratio requirements file
  164. ========
  165.  
  166. Edit the requirement file, PCBURM.REQ. Use your favorite text editor to
  167. edit this file: The format is as follows:
  168.  
  169. SECURITY LEVEL, FILE RATIO, BYTE RATIO, USER COMMENT
  170.  
  171. For example:
  172.  
  173. 30,5,10,Regular User
  174. 40,10,20,Supporting User - Thanks for your payment
  175. 200,0,0,Sysop
  176. 999,1,1,Unknown Access Level - Please inform sysop
  177.  
  178. In the above example, the first line is for a security level 30 user. He has a
  179. 5:1 file ratio requirement, a 10:1 byte ratio requirement. The USER COMMENT
  180. field ("Regular User") will be displayed as part of the user statistics
  181. displayed by the program. You can use this field to put any information you
  182. desire, maybe enter information about subscription that your board may offer.
  183.  
  184. In the second example, this is for a security level 40 user. He has a 10:1
  185. file ratio requirement and a 20:1 byte ratio requirement.
  186.  
  187. In the third example, this is a security level 200 user. The file and byte
  188. ratios have been set to "0", this informs PCBURM that this user is exempt for
  189. maintaining any ratio requirements (might be used for subscribing user,
  190. co-sysops and sysops). You may set the byte and/or file ratio to zero if you
  191. do not with to enforce a ratio requirement.
  192.  
  193. The last example is recommended as the last line for every PCBURM.REQ file.
  194. This is used as the DEFAULT security ratio. If a security level is not found
  195. in the line preceeding this last line, these ratios will be assigned to the
  196. user. Using the above example, if the user had a security level of 60, PCBURM
  197. would use the file requirements as shown on this line as a level 60 was not
  198. previously assigned a ratio requirement.
  199.  
  200.  
  201.  
  202. Step #3 - Setup PCBURM as a door
  203. =======
  204.  
  205. Setup PCBURM as a PCBoard Door.  Run PCBSetup, edit the door security file and
  206. add the following line:
  207.  
  208.                                   USER DOOR
  209.  Filename    Password   Sec Login SYS  SYS  Shell Path to DOOR Files
  210. ══════════ ════════════ ═══ ═════ ════ ════ ═════ ═══════════════════     
  211. PCBURM                   0    Y    Y    N     Y
  212.  
  213. The "Login" and "Shell" are both optional. If you have enough memory, it is
  214. recommended that you use the "shell" option of PCBoard. The USERS.SYS field
  215. must be set to Y or PCBURM will not work!
  216.  
  217.  
  218. Step #4 - Create script file
  219. =======
  220.  
  221. Edit the PCBURM door script, again using your favorite text editor. Below is
  222. an example of a suggested script (example presumes PCBURM is located on drive
  223. "C" and in directory "PCBURM"):
  224.  
  225.      @ECHO OFF
  226.      C:
  227.      CD \PCBURM
  228.      PCBURM PCBURM.CFG
  229.      %PCBDRIVE%
  230.      CD %PCBDIR%
  231.      IF (%INPCB%)==(Y) EXIT
  232.      BOARD
  233.  
  234. The line "IF (%INPCB%)==(Y) EXIT" is used to exit from shelled doors. If you
  235. won't run PCBURM as a shelled door, it may be removed.
  236.  
  237. PCBURM supports COM1-4, using standard IRQ's. If you wish to use a
  238. non-standard IRQ, add the IRQ number after the configuration file name. For
  239. example "PCBURM PCBURM.CFG /5" (tells PCBURM to use IRQ 5 instead of standard
  240. IRQ value). No parameter is required if using standard IRQ values.
  241.  
  242. |Some users may have had conflicts when using non-standard IRQ's on
  243. |Novell/Netware systems. Novell seems to use the "/" character for
  244. |parameter passing. You may not optionally use the "*" character instead
  245. |of the "/".
  246.  
  247.  
  248. That's all there is to do. PCBURM will adjust the daily download bytes allowed
  249. as indicated in the PWRD file to monitor and enforce the file/byte ratio's. If
  250. you have used another file ratio enforcement program, check to see that you
  251. have re-entered this information in the PWRD file (some ratio enforcers have
  252. required you to zero out this information. Not PCBURM, PCBURM reads this
  253. information.
  254.  
  255. When PCBURM is run, it will display the users file/byte statistics. It will
  256. also display if the user is within your established ratio requirements, or if
  257. not, will inform him accordingly. In addition, PCBURM will maintain a log file
  258. (PCBURM.LOG) which will indicate what actions were taken by the program, or if
  259. the user was within ratio requirements. You may wish to delete this file
  260. regularly as necessary.
  261.  
  262.  
  263. |FOSSIL DRIVER
  264. |=============
  265. |
  266. |Links Golf now includes support for FOSSIL drivers. This means that the
  267. |program will now work with Digiboard (for PCBoard/M versions) and other
  268. |multi-port boards. To activate the Fossil driver support just include
  269. |/FD on the command line in your door batch file.
  270. |        For example: PCBURM PCBURM.CFG /FD
  271. |
  272. |If no Fossil driver is available, PCBURM will display a message
  273. |indicating such and exit cleanly.
  274.  
  275.  
  276.  
  277.  
  278.  
  279.                               REGISTRATION
  280.                               ============
  281.  
  282. PCBURM is released as user support software (aka SHAREWARE). I don't expect
  283. you to register the program if you don't like it or if it doesn't meet your
  284. needs (just stop using it). But if you continue to use PCBURM after a
  285. reasonable evaluation period of up to 30 days, you are required to make
  286. payment for the program or stop using it.
  287.  
  288. PCBURM is NOT crippled in any way other than for a momentary reminder at the
  289. termination of the program that the program is not registered. Once you
  290. register the program, you will be provided with a registration number which
  291. will remove this reminder notice.
  292.  
  293. Registration is only $15 and will include unlimited free upgrades and support
  294. via my BBS.
  295.  
  296. Please use the form REGISTER.FRM included with the program to register PCBURM.
  297. If this file is missing, send a check for $15 (US funds) to:
  298.  
  299.         Robert Neal
  300.         317 Hickory
  301.         Romeoville, IL  60441
  302.  
  303. Please include your BBS name as this information will be used to create your
  304. unique registration key file. You may receive your registration file via my
  305. support BBS (but please be sure you have an account established on my BBS so
  306. that I can leave this information in a private message to you) or via the US
  307. Mail. Please indicate your preference.
  308.  
  309. Keep your eye open for other utility programs from me written for PCBoard.
  310. Several programs are now in the works and should be released soon. Also, look
  311. for my door programs, Card Sharks and Links Golf (available on my BBS as
  312. well), I think your users will enjoy playing them.
  313.  
  314.  
  315.                               TROUBLESHOOTING
  316.                            =====================
  317.  
  318. If you are running this on a 486 system with co-processor, you may need
  319. to put 'SET NO87=ON' in your AUTOEXEC.BAT file or you may place this in
  320. the PCBURM batch file just before the line PCBURM PCBURM.CFG, for
  321. example:
  322.  
  323.      @ECHO OFF
  324.      C:
  325.      CD \PCBURM
  326.      SET NO87=ON
  327.      PCBURM PCBURM.CFG
  328.      %PCBDRIVE%
  329.      CD %PCBDIR%
  330.      IF (%INPCB%)==(Y) EXIT
  331.      BOARD
  332.  
  333.  
  334. If you are running on a 486 system with co-processor under DesqView, you
  335. may alternately set Math Coprocessor in each window to YES.
  336.  
  337.  
  338.  
  339.  
  340.                                   SUPPORT
  341.                             ===================
  342.  
  343. If you have any questions, comments, problems, suggestions for enhancements,
  344. etc., I may be reached at my support BBS or by mail. In addition, you may send
  345. a message to me on the RIME conferences to my BBS "CHQBBS", I regularly
  346. monitor the messages in the Sysop, BBS and PCBoard Support conferences. I can
  347. also be reached via Prodigy, PNSP01A.
  348.  
  349.  
  350.  
  351.                              LEGAL INFORMATION
  352.                       ===============================
  353.  
  354. This program is provided on an "AS IS" basis.  No warranty of any kind is
  355. expressed or implied.  YOU USE THIS PROGRAM AT YOUR OWN RISK.  I take no
  356. responsibility for any damage caused directly or indirectly from the use or
  357. the inability to use this program.
  358.